// Command.cs
//  
// Author:  WOnder93 <omosnacek@gmail.com>
// 
// Copyright (c) 2012 Ondrej Mosnáček
// 
// Created with the help of the source code of KBang (http://code.google.com/p/kbang)
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
using System.Collections.Generic;

namespace BangSharp.ConsoleUtils
{
	/// <summary>
	/// Represents a command template.
	/// </summary>
	/// <typeparam name="In">
	/// The type of the input parameter of the command template.
	/// </typeparam>
	public abstract class Command<In> : ICommand
	{
		/// <summary>
		/// Gets the subcommands of this command template.
		/// </summary>
		/// <value>
		/// The subcommands of this command template.
		/// </value>
		public abstract IEnumerable<string> Subcommands { get; }
		/// <summary>
		/// Gets the subcommand template with the specified name.
		/// </summary>
		/// <returns>
		/// The subcommand template with the specified name.
		/// </returns>
		/// <param name="text">
		/// The name of the subcommand to get.
		/// </param>
		public abstract ICommand GetSubcommand(string text);
		/// <summary>
		/// Executes the command.
		/// </summary>
		/// <param name="param">
		/// The input parameter of the command template.
		/// </param>
		/// <param name="cmd">
		/// The command name queue.
		/// </param>
		public abstract void Execute(In param, Queue<string> cmd);
	}
}
